<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: mapping - classes representing mathematical mappings</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00519.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#groups">Modules</a>  </div>
  <div class="headertitle">
<div class="title">mapping - classes representing mathematical mappings</div>  </div>
</div>
<div class="contents">
<div class="dynheader">
Collaboration diagram for mapping - classes representing mathematical mappings:</div>
<div class="dyncontent">
<center><table><tr><td><img src="a00519.png" border="0" alt="" usemap="#a00519"/>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00085.html">Dimension</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies a dimension for mappings (like time, frequency, etc.)  <a href="a00085.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00086.html">DimensionSet</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a set of dimensions which is used to define over which dimensions a mapping is defined (the domain of the mapping).  <a href="a00086.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00013.html">Argument</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines an argument for a mapping.  <a href="a00013.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html">NoNextIteratorException</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">This exception is thrown by the MappingIterators when "next()" or "nextPosition()" is called although "hasNext()" would return false (means there is no next position).  <a href="a00163.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00059.html">ConstMappingIterator</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines an const iterator for a <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> which is able to iterate over the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a>.  <a href="a00059.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00058.html">ConstMapping</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a not changeable mapping (mathematical function) from domain with at least the time to a Argument::mapped_type value.  <a href="a00058.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html">MappingIterator</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines an iterator for a <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a> which is able to iterate over the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a>.  <a href="a00137.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html">Mapping</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.  <a href="a00136.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00195.html">SimpleConstMappingIterator</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A fully working ConstIterator-implementation usable with almost every <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a>.  <a href="a00195.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html">SimpleConstMapping</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract subclass of <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> which can be used as base for any <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> implementation with read access of constant complexity.  <a href="a00194.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00213.html">TimeMappingIterator&lt; Interpolator &gt;</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides an implementation of the MappingIterator- Interface which is able to iterate over TimeMappings.  <a href="a00213.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html">TimeMapping&lt; Interpolator &gt;</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements the Mapping-interface with an <a class="el" href="a00110.html" title="Represents a std::map which is able to interpolate.">InterpolateableMap</a> from simtime_t to double between which values can be interpolated to represent a <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a> with only time as domain.  <a href="a00212.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00055.html">ConstantSimpleConstMapping</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a constant mathematical mapping (f(x) = c)  <a href="a00055.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html">MultiDimMappingIterator&lt; Interpolator &gt;</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Implementation of the MappingIterator-interface which is able to iterate over every value in a <a class="el" href="a00148.html" title="Implementation of the Mapping-interface which is able to represent arbitrary dimensional instances of...">MultiDimMapping</a>.  <a href="a00149.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00148.html">MultiDimMapping&lt; Interpolator &gt;</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Implementation of the Mapping-interface which is able to represent arbitrary dimensional instances of Mappings by using a tree-like structure of sub-mappings, each representing the values for one of the dimensions.  <a href="a00148.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00138.html">MappingUtils</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides several utility methods for Mappings.  <a href="a00138.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html">JakesFadingMapping</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a> used to represent attenuation of a signal by <a class="el" href="a00114.html" title="Implements Rayleigh fading after Jakes&#39; model.">JakesFading</a>.  <a href="a00115.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00198.html">SimplePathlossConstMapping</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a> that represents a Pathloss-function.  <a href="a00198.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00200.html">SimpleTimeConstMapping</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: short description for this class.  <a href="a00200.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="groups"></a>
Modules</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00520.html">mappingDetails - mostly internal mapping classes</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>The following class graph shows an overview of the most important classes used by Mappings.</p>
<div class="image">
<img src="MappingDetail.png" alt="MappingDetail.png"/>
</div>
<p>There a two types of mapping interfaces, <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> and <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a>. <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> can represent any mathematical mapping but the the course of the mapping can't be set or changed arbitrary. This interface is meant to be used for implementations which define the course of the mapping by a concrete formula. The <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a> interface extends the <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> interface by a setValue() method which can set and change the course of the represented mapping arbitrary. This interface is meant to be used for generic mapping implementations which uses methods like interpolation to be able to represent any arbitrary course of a mapping.</p>
<p>Every <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> (and therefore every <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a>) has a <a class="el" href="a00086.html" title="Represents a set of dimensions which is used to define over which dimensions a mapping is defined (th...">DimensionSet</a> member which defines the domain of the represented mapping. The <a class="el" href="a00086.html" title="Represents a set of dimensions which is used to define over which dimensions a mapping is defined (th...">DimensionSet</a> class itself is an actual set of <a class="el" href="a00085.html" title="Specifies a dimension for mappings (like time, frequency, etc.)">Dimension</a> objects. Each <a class="el" href="a00085.html" title="Specifies a dimension for mappings (like time, frequency, etc.)">Dimension</a> object represents a certain dimension like time or frequency.</p>
<p>Further <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> and <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a> define their own Iterator interfaces <a class="el" href="a00059.html" title="Defines an const iterator for a ConstMapping which is able to iterate over the Mapping.">ConstMappingIterator</a> and <a class="el" href="a00137.html" title="Defines an iterator for a Mapping which is able to iterate over the Mapping.">MappingIterator</a> which define the interface for iterators over a mapping implementation.</p>
<p>The last important class is the <a class="el" href="a00013.html" title="Defines an argument for a mapping.">Argument</a>. It defines a position in a mappings domain by mapping a number of Dimensions to the value inside that <a class="el" href="a00085.html" title="Specifies a dimension for mappings (like time, frequency, etc.)">Dimension</a>. </p>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:31 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
